Finance APIs

GET finance/bank-accounts/{bankAccountId}

Bank account details for provided identifier

HTTP method	GET
URI	https://api.rambase.net/finance/bank-accounts/{bankAccountId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {bankAccountId}	Bank account identifier Integer, minimum 100
Successful HTTP status code	200
API resource identifier	494, version 31

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional	Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <BankAccount>
                                    

<BankAccountId

BankAccountId

Bank account identifier

>{Integer}</BankAccountId>

<Status

Status

Status of bank account

Possible domain values can be found here

>{Integer}</Status>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<Name

Name

Name of bank account

>{String}</Name>

<AccountNumber

AccountNumber

Account number used to identify the bank account

>{String}</AccountNumber>

<Type

Type

Type of the bank account, f.e. BBAN, Bankgiro, Plusgiro, ...

Possible domain values can be found here

>{String}</Type>

<Currency

Currency

Currency used for the bank account

>{String}</Currency>

<IBAN

IBAN

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

>{String}</IBAN>

<Category

RequireStructuredPaymentReference

Structured reference to the payment

>{Boolean}</RequireStructuredPaymentReference>

<IsDefaultForRemittance

IsDefaultForRemittance

Determines if this is default bank for outgoing payments

>{Boolean}</IsDefaultForRemittance>

<RemittanceHandling

RemittanceHandling

Methods of transfer payment

Possible domain values can be found here

>{String}</RemittanceHandling>

<RegionalId

RegionalId

Regional bank identifier of the bank account

>{String}</RegionalId>

<MinimumPaymentAmountForReporting

MinimumPaymentAmountForReporting

In some cases the payment needs a reporting code and the reporting limit will be used for the minimum payment amount

>{Integer}</MinimumPaymentAmountForReporting>

<ExternalClearingSystemIdentificationCode

ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

<Code

Code

Clearing code of the bank account

Possible domain values can be found here

>{String}</Code>

<BankIdentifier

BankIdentifier

Clearing bank identifier of the bank account

>{String}</BankIdentifier>

                                             </ExternalClearingSystemIdentificationCode>
                                    

                                             <Bank>
                                    

<SWIFTCode

SWIFTCode

The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.

>{String}</SWIFTCode>

<Phone

Phone

Bank phone number

>{String}</Phone>

<Fax

Fax

Fax number for bank account

>{String}</Fax>

<Address

Address

Address of the bank associated with the bank account

<AddressLine1

AddressLine1

First address line

>{String}</AddressLine1>

<AddressLine2

AddressLine2

Second address line

>{String}</AddressLine2>

<PostalCode

PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>

<City

City

City/town/village

>{String}</City>

<Country

Country

English name of country.

>{String}</Country>

<CountryCode

CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>

                                                  </Address>
                                    

                                             </Bank>
                                    

<GeneralLedgerAccount

GeneralLedgerAccount

Finance account associated with the bank account

<GeneralLedgerAccountId

GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>

<AccountNumber

AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>

<Name

Name

Name of general ledger account

>{String}</Name>

<GeneralLedgerAccountLink

GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>

                                             </GeneralLedgerAccount>
                                    

                                             <LatestReceivedBankStatement>
                                    

<BankStatementId

BankStatementId

Bank statement identifier

>{Integer}</BankStatementId>

<BankStatementLink

BankStatementLink

Bank statement reference

>{String}</BankStatementLink>

<BookingDate

BookingDate

Booking date of the bank statement

>{Date}</BookingDate>

                                                  <Totals>
                                    

<OpeningBalance

OpeningBalance

Opening balance of bank statement

>{Decimal}</OpeningBalance>

<ClosingBalance

ClosingBalance

Closing balance of bank statement

>{Decimal}</ClosingBalance>

                                                  </Totals>
                                    

                                             </LatestReceivedBankStatement>
                                    

                                             <IsUsedFor>
                                    

<Clearing

Clearing

Indicates if the bank account is used for clearing

>{Boolean}</Clearing>

<VATSettlement

VATSettlement

Indicates if the bank account is used for VAT settlement

>{Boolean}</VATSettlement>

<CreditCardTransaction

CreditCardTransaction

Indicates if the bank account can be used for credit card payments

>{Boolean}</CreditCardTransaction>

<Factoring

Factoring

Indicates if the bank account is used for factoring

>{Boolean}</Factoring>

                                             </IsUsedFor>
                                    

                                             <IsUsedOnOutput>
                                    

<SalesInvoice

SalesInvoice

Indicates if the bank account is used on print for outgoing invoices

>{Boolean}</SalesInvoice>

<ProformaInvoiceBasedOnSalesOrder

ProformaInvoiceBasedOnSalesOrder

Indicates if the bank account is used on print for proforma invoices, based on sales order

>{Boolean}</ProformaInvoiceBasedOnSalesOrder>

<ProformaInvoiceBasedOnShippingAdvice

ProformaInvoiceBasedOnShippingAdvice

Indicates if the bank account is used on print for proforma invoices, based on shipping advice

>{Boolean}</ProformaInvoiceBasedOnShippingAdvice>

<Dunning

Dunning

Indicates if the bank account is used on print for dunnings

>{Boolean}</Dunning>

                                             </IsUsedOnOutput>
                                    

                                             <RamBaseBankIntegration>
                                    

                                                  <ProductTerms>
                                    

<AcceptedAt

AcceptedAt

The date of acceptance the use of BankConnector

>{Date}</AcceptedAt>

                                                       <AcceptedBy>
                                    

<EmployeeId

EmployeeId

Employee identifier

>{Integer}</EmployeeId>

<LastName

LastName

Last name of employee

>{String}</LastName>

<FirstName

FirstName

First name of employee

>{String}</FirstName>

<EmployeeLink

EmployeeLink

Employee reference

>{String}</EmployeeLink>

                                                       </AcceptedBy>
                                    

                                                  </ProductTerms>
                                    

<ImportBankStatements

ImportBankStatements

Indicates if the bank statements will be handled via the BankConnector

>{Boolean}</ImportBankStatements>

<SendRemittance

SendRemittance

Indicates if the remittances will be handled via the BankConnector

>{Boolean}</SendRemittance>

<ImportIncomingPayments

ImportIncomingPayments

Indicates if the incoming payments will be handled via the BankConnector

>{Boolean}</ImportIncomingPayments>

<UserName

UserName

User name used to connect to BankConnector

>{String}</UserName>

<IsPasswordSet

IsPasswordSet

Indicates if the password to the BankConnector was set

>{Boolean}</IsPasswordSet>

<ContractId

ContractId

Contract identifier used in BankConnector

>{String}</ContractId>

                                             </RamBaseBankIntegration>
                                    

<PaymentTotals

PaymentTotals

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

<Currency

Currency

Currency used for the bank account

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

>{String}</Currency>

<PendingInternalAction

PendingInternalAction

The sum of the values of pending internal action payments

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

>{Decimal}</PendingInternalAction>

<PendingConfirmation

PendingConfirmation

The sum of the values of pending confirmation payments

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

>{Decimal}</PendingConfirmation>

<Confirmed

Confirmed

The sum of the values of confirmed payments

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

>{Decimal}</Confirmed>

<Reconciled

Reconciled

The sum of the values of reconciled payments

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

>{Decimal}</Reconciled>

<ConfirmedAndReconciled

ConfirmedAndReconciled

The sum of the values of confirmed and reconciled payments

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

>{Decimal}</ConfirmedAndReconciled>

<CurrentBalance

CurrentBalance

Opening balance for current year

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

>{Decimal}</CurrentBalance>

                                             </PaymentTotals>
                                    

                                        </BankAccount>
                                    

{

                                             "bankAccount": {
                                    

"bankAccountId

BankAccountId

Bank account identifier

": "{Integer}",

"status

Status

Status of bank account

Possible domain values can be found here

": "{Integer}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"name

Name

Name of bank account

": "{String}",

"accountNumber

AccountNumber

Account number used to identify the bank account

": "{String}",

"type

Type

Type of the bank account, f.e. BBAN, Bankgiro, Plusgiro, ...

Possible domain values can be found here

": "{String}",

"currency

Currency

Currency used for the bank account

": "{String}",

"iBAN

IBAN

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

": "{String}",

"category

RequireStructuredPaymentReference

Structured reference to the payment

": "{Boolean}",

"isDefaultForRemittance

IsDefaultForRemittance

Determines if this is default bank for outgoing payments

": "{Boolean}",

"remittanceHandling

RemittanceHandling

Methods of transfer payment

Possible domain values can be found here

": "{String}",

"regionalId

RegionalId

Regional bank identifier of the bank account

": "{String}",

"minimumPaymentAmountForReporting

MinimumPaymentAmountForReporting

In some cases the payment needs a reporting code and the reporting limit will be used for the minimum payment amount

": "{Integer}",

"externalClearingSystemIdentificationCode

ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

": {

"code

Code

Clearing code of the bank account

Possible domain values can be found here

": "{String}",

"bankIdentifier

BankIdentifier

Clearing bank identifier of the bank account

": "{String}"

},

                                                  "bank": {
                                    

"sWIFTCode

SWIFTCode

": "{String}",

"phone

Phone

Bank phone number

": "{String}",

"fax

Fax

Fax number for bank account

": "{String}",

"address

Address

Address of the bank associated with the bank account

": {

"addressLine1

AddressLine1

First address line

": "{String}",

"addressLine2

AddressLine2

Second address line

": "{String}",

"postalCode

PostalCode

Postalcode/Postcode/ZIP

": "{String}",

"city

City

City/town/village

": "{String}",

"country

Country

English name of country.

": "{String}",

"countryCode

CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}"

}

},

"generalLedgerAccount

GeneralLedgerAccount

Finance account associated with the bank account

": {

"generalLedgerAccountId

GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",

"accountNumber

AccountNumber

The account number of the general ledger account

": "{String}",

"name

Name

Name of general ledger account

": "{String}",

"generalLedgerAccountLink

GeneralLedgerAccountLink

General ledger account reference

": "{String}"

},

                                                  "latestReceivedBankStatement": {
                                    

"bankStatementId

BankStatementId

Bank statement identifier

": "{Integer}",

"bankStatementLink

BankStatementLink

Bank statement reference

": "{String}",

"bookingDate

BookingDate

Booking date of the bank statement

": "{Date}",

                                                       "totals": {
                                    

"openingBalance

OpeningBalance

Opening balance of bank statement

": "{Decimal}",

"closingBalance

ClosingBalance

Closing balance of bank statement

": "{Decimal}"

}

},

                                                  "isUsedFor": {
                                    

"clearing

Clearing

Indicates if the bank account is used for clearing

": "{Boolean}",

"vATSettlement

VATSettlement

Indicates if the bank account is used for VAT settlement

": "{Boolean}",

"creditCardTransaction

CreditCardTransaction

Indicates if the bank account can be used for credit card payments

": "{Boolean}",

"factoring

Factoring

Indicates if the bank account is used for factoring

": "{Boolean}"

},

                                                  "isUsedOnOutput": {
                                    

"salesInvoice

SalesInvoice

Indicates if the bank account is used on print for outgoing invoices

": "{Boolean}",

"proformaInvoiceBasedOnSalesOrder

ProformaInvoiceBasedOnSalesOrder

Indicates if the bank account is used on print for proforma invoices, based on sales order

": "{Boolean}",

"proformaInvoiceBasedOnShippingAdvice

ProformaInvoiceBasedOnShippingAdvice

Indicates if the bank account is used on print for proforma invoices, based on shipping advice

": "{Boolean}",

"dunning

Dunning

Indicates if the bank account is used on print for dunnings

": "{Boolean}"

},

                                                  "ramBaseBankIntegration": {
                                    

                                                       "productTerms": {
                                    

"acceptedAt

AcceptedAt

The date of acceptance the use of BankConnector

": "{Date}",

                                                            "acceptedBy": {
                                    

"employeeId

EmployeeId

Employee identifier

": "{Integer}",

"lastName

LastName

Last name of employee

": "{String}",

"firstName

FirstName

First name of employee

": "{String}",

"employeeLink

EmployeeLink

Employee reference

": "{String}"

}

},

"importBankStatements

ImportBankStatements

Indicates if the bank statements will be handled via the BankConnector

": "{Boolean}",

"sendRemittance

SendRemittance

Indicates if the remittances will be handled via the BankConnector

": "{Boolean}",

"importIncomingPayments

ImportIncomingPayments

Indicates if the incoming payments will be handled via the BankConnector

": "{Boolean}",

"userName

UserName

User name used to connect to BankConnector

": "{String}",

"isPasswordSet

IsPasswordSet

Indicates if the password to the BankConnector was set

": "{Boolean}",

"contractId

ContractId

Contract identifier used in BankConnector

": "{String}"

},

"paymentTotals

PaymentTotals

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

": {

"currency

Currency

Currency used for the bank account

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

": "{String}",

"pendingInternalAction

PendingInternalAction

The sum of the values of pending internal action payments

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

": "{Decimal}",

"pendingConfirmation

PendingConfirmation

The sum of the values of pending confirmation payments

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

": "{Decimal}",

"confirmed

Confirmed

The sum of the values of confirmed payments

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

": "{Decimal}",

"reconciled

Reconciled

The sum of the values of reconciled payments

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

": "{Decimal}",

"confirmedAndReconciled

ConfirmedAndReconciled

The sum of the values of confirmed and reconciled payments

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

": "{Decimal}",

"currentBalance

CurrentBalance

Opening balance for current year

This field is greyed out because it is an expandable field. You have to add $expand=PaymentTotals in your request URI to get this field

": "{Decimal}"

}

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

POST

Bank connector - Get bank statement for given date

Set minimum payment amount for reporting

AOP/101752

POST

Bank connector - Get bank statement for given date (test)

AOP/101775

POST

Bank connector - Get bank balance for given date

AOP/101776

POST

Bank connector - Get bank balance for given date (test)

AOP/101777

Possible error codes the response might return:

Error 101999 HTTP 404	Bank account not found
Error 104558 HTTP 400	The YEAR parameter is invalid